-
-
Notifications
You must be signed in to change notification settings - Fork 77
ci(release): Switch from action-prepare-release to Craft #1186
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
This PR migrates from the deprecated action-prepare-release to the new Craft GitHub Actions (reusable workflow or composite action). Changes: - Migrate .github/workflows/release.yml to Craft reusable workflow
Semver Impact of This PR⚪ None (no version bump detected) 📋 Changelog PreviewThis is how your changes will appear in the changelog. Bug Fixes
Internal Changes
🤖 This preview updates automatically when you update the PR. |
The previous migration incorrectly removed the GitHub App token authentication step. This commit restores it by switching to the composite action pattern which preserves the auth flow.
| run: yarn install | ||
| - name: Prepare release | ||
| uses: getsentry/action-prepare-release@v1 | ||
| uses: getsentry/craft@c6e2f04939b6ee67030588afbb5af76b127d8203 # v2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: The version input for the release workflow is optional. If not provided, it passes an empty string to the craft action, which may cause the workflow to fail.
Severity: MEDIUM
Suggested Fix
To prevent potential failures, provide a default value for the version input. For example, setting default: 'auto' would align with the input's description and ensure the craft action receives a valid, expected value when the input is not manually specified.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: .github/workflows/release.yml#L40
Potential issue: In the `release.yml` workflow, the `version` input is now optional
(`required: false`) and lacks a default value. When this workflow is triggered manually
without providing a version, GitHub Actions passes an empty string (`''`) to the
`getsentry/craft` action. It is uncertain if the `craft` action is designed to handle an
empty string for its `version` parameter. If it is not, this could cause the release
process to fail when a version is not explicitly provided during a manual trigger.
Did we get this right? 👍 / 👎 to inform future reviews.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@BYK I believe this is no longer required because the action would determine the release automatically, unless manually specified, correct?
Summary
This PR migrates from the deprecated
action-prepare-releaseto the new Craft GitHub Actions.Changes
.github/workflows/release.ymlto Craft reusable workflowDocumentation
See https://getsentry.github.io/craft/github-actions/ for more information.